Skip to main content
POST
Create an experiment.

Authorizations

Authorization
string
header
required

Bearer authentication. Pass the access token in the Authorization: Bearer <token> header.

Body

application/json
buckets
BucketCreate · object[]
required
Required array length: 1 - 15 elements
end_date
string<date-time>
required

End date of the experiment (UTC).

name
string
required

Human-readable name of the experiment.

start_date
string<date-time>
required

Start date of the experiment (UTC).

target_id
string<uuid>
required

Identifier of the target entity.

target_type
enum<string>
required

Type of the target entity (ad unit or placement).

Available options:
ad_unit,
placement
ext
any | null

Extension field for additional experiment-specific data.

status
enum<string>
default:inactive

Lifecycle status of the experiment.

Available options:
inactive,
active,
completed

Response

Successful Response

Response schema for experiment records.

created_at
string<date-time>
required
end_date
string<date-time>
required

End date of the experiment (UTC).

id
string<uuid>
required

Unique identifier for the experiment (UUID v4).

name
string
required

Human-readable name of the experiment.

start_date
string<date-time>
required

Start date of the experiment (UTC).

target_id
string<uuid>
required

Identifier of the target entity.

target_type
enum<string>
required

Type of the target entity (ad unit or placement).

Available options:
ad_unit,
placement
updated_at
string<date-time>
required
buckets
ExperimentBucket · object[]

Buckets defining traffic splits and line item assignments.

Required array length: 1 - 15 elements
ext
any | null

Extension field for additional experiment-specific data.

no
integer | null
status
enum<string>
default:inactive

Lifecycle status of the experiment.

Available options:
inactive,
active,
completed